/*
 * Copyright (c) 2014. Real Time Genomics Limited.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.rtg;

/**
 * Category of a command. Used for grouping in the command line usage help.
 */
public enum CommandCategory {
  /** Format commands */
  FORMAT("Data formatting"),
  /** Mapping commands */
  MAPPING("Read mapping"),
  /** Protein search */
  PROTEIN("Protein search"),
  /** Variant detection commands */
  VARIANT("Variant detection"),
  /** Metagenomics. */
  METAGENOMICS("Metagenomics"),
  /** Pipeline commands */
  PIPELINES("Pipelines"),
  /** Simulate commands */
  SIMULATE("Simulation"),
  /** Information commands */
  UTILITY("Utility"),
  /** Assembly commands */
  ASSEMBLY("Assembly");

  private final String mLabel;

  CommandCategory(String label) {
    mLabel = label;
  }

  /**
   * @return the display name of the category
   */
  public String getLabel() {
    return mLabel;
  }
}
